Xceed .NET Libraries Documentation
Xceed.Tar Assembly / Xceed.Tar Namespace / QuickTar Class / Remove Method / Remove(String,Boolean,Boolean,String[]) Method
The full path of the Tar archive.
Boolean value indicating whether files contained within sub-folders should be removed from the Tar file.
Boolean value indicating if the tar file was compressed using GZip. Note: The GZip file retrieved must have the following format: tarFileName.gz. An exception is thrown if the Tar archive is not compressed.
The files to remove from tarFileName. Cannot be NULL.
Example


In This Topic
    Remove(String,Boolean,Boolean,String[]) Method
    In This Topic
    Removes files from a Tar archive, specifying whether files contained within sub-folders will also be removed.
    Syntax
    'Declaration
     
    
    Public Overloads Shared Sub Remove( _
       ByVal tarFileName As String, _
       ByVal recursive As Boolean, _
       ByVal isTarCompressed As Boolean, _
       ByVal ParamArray filesToRemove() As String _
    ) 
    'Usage
     
    
    Dim tarFileName As String
    Dim recursive As Boolean
    Dim isTarCompressed As Boolean
    Dim filesToRemove() As String
     
    QuickTar.Remove(tarFileName, recursive, isTarCompressed, filesToRemove)
    public static void Remove( 
       string tarFileName,
       bool recursive,
       bool isTarCompressed,
       params string[] filesToRemove
    )

    Parameters

    tarFileName
    The full path of the Tar archive.
    recursive
    Boolean value indicating whether files contained within sub-folders should be removed from the Tar file.
    isTarCompressed
    Boolean value indicating if the tar file was compressed using GZip. Note: The GZip file retrieved must have the following format: tarFileName.gz. An exception is thrown if the Tar archive is not compressed.
    filesToRemove
    The files to remove from tarFileName. Cannot be NULL.
    Remarks

    Tar files are case sensitive; therefore, the string passed in the filesToRemove parameter will be used "as-is".

    For example, if a Tar archive contains a file named "FILE.TXT" and "file.txt" is passed to the filesToRemove parameter, "FILE.TXT" will not be removed.

    This implementation of Tar is fully read/write compatible with the USTAR format. It is read compatible with GNU Tar archives whose entries do not use the header extensions of this format.

    Example
    NULL
    Example
    NULL
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also